Sequence diagrams
The message models can be found in Semantic Treehouse. There you can also find example messages and validation artifacts in both XML and JSON.
The REST API specifications can be found here: Inquiry Pay Equity API specifications
The page contains several sequence diagrams illustrating the communication between the backoffice systems of a staffing supplier and a staffing customer and a CAO service provider for exchanging the SETU Inquiry Pay Equity message
Sending Inquiry Pay Equity data: Staffing Supplier to Staffing Customer
The staffing supplier can request the inquiry pay equity message from the staffing customer when necessary. This is currently out-of-scope, but might be done by sending a PUT /inquiry-pay-equity/request* to the staffing customer. Upon receiving the request, the staffing customer processes it and returns the relevant inquiry pay equity data. This is done by sending a PUT /inquiry-pay-equity/{resourceID} request. The resourceID serves as the unique identifier for the resource. This identifier can be passed as a query parameter in the path of the request. It enables the API client to perform GET, PUT, and DELETE operations on the resource later. For more information, read here.
These inquiry-pay-equity request API calls are currently out of scope. The inquiry-pay-equity API request is not comparable to the request (uitvraag) made by CAO service providers. This request concerns the trigger for sending the pay equity data.
Updating Inquiry Pay Equity: Staffing Supplier to Staffing Customer
The staffing customer may need to update the inquiry-pay-equity when there is a change in the remuneration or other relevant information.See below in the details panel how the sequence diagram looks.
Updating an existing inquiry-pay-equity
The staffing customer may need to update the inquiry-pay-equity when there is a change in the remuneration or other relevant information. This is initiated when the staffing customer sends a PUT /inquiry-pay-equity/{resourceID} to the staffing supplier, which includes the updated information. The staffing supplier receives this update and processes it accordingly. It responds with a 200 and the updated request body.
Getting Inquiry Pay Equity: Staffing Supplier to Staffing Customer
The staffing supplier can request the inquiry-pay-equity from the staffing customer when necessary. This might be done by sending a GET /inquiry-pay-equity/{resourceID} to the staffing customer. Upon receiving the request, the staffing customer processes it and returns the relevant inquiry-pay-equity data, typically with a 200 OK response.
Getting an inquiry-pay-equity
Staffing Supplier to CAO Service Provider
The exchanges with the CAO service provider follow the same process. Below, in the various detail panels, you can also find the sequence diagrams for this.
Sending an inquiry-pay-equity
Updating an existing inquiry-pay-equity
The CAO service provider may need to update the inquiry-pay-equity when there is a change in the remuneration or other relevant information. This is initiated when the CAO service provider sends a PUT /inquiry-pay-equity/{resourceID} to the staffing supplier, which includes the updated information. The staffing supplier receives this update and processes it accordingly. It responds with a 200 and the updated request body.